home *** CD-ROM | disk | FTP | other *** search
/ The Pier Shareware 9 / The Pier Shareware #9 (Pier Exchange).ISO / thepier / thepier.doc < prev    next >
Text File  |  1996-03-03  |  16KB  |  380 lines
  1.  
  2.  
  3.                       The Pier Shareware CD-ROM
  4.                  Copyright (c) 1995 The Pier Exchange
  5.                          All rights reserved.
  6.  
  7.              ThePier(tm) - High Performance CD-ROM Access
  8.  
  9.  
  10.  
  11.  
  12.                           Retrieval Engine
  13.                  Copyright (c) 1995 RoboSoft Systems.
  14.                          All rights reserved.
  15.  
  16.  
  17.  
  18.  
  19.                          Table of Contents
  20.  
  21.     1 ........................................ Introduction
  22.     2 ........................................ Installation
  23.     3 ..................................... Basic Operation
  24.     4 .................................... The Subject List
  25.     4.1 ............................. The Subject List Menu
  26.     4.1.1 ................................. The System Menu
  27.     4.1.2 ................................. The Search Menu
  28.     4.1.3 .............................. The Configure Menu
  29.     4.1.3.1 ............................. Configure Display
  30.     4.1.3.2 ............................ Configure Database
  31.     4.1.3.3 ......................... Configure Directories
  32.     4.1.3.4 ............................. Configure Viewers
  33.     4.1.3.4.1 .............................. Default Viewer
  34.     4.1.3.4.2 ................................ Custom Shell
  35.     4.1.3.4.3 ............................... Smart Viewers
  36.     5 ...................................... The Files List
  37.     5.1 ............................... The Files List Menu
  38.     6 .............................. The File Detail Screen
  39.     6.1 .................................. The Content List
  40.     6.2 .............................. The File Detail Menu
  41.     7 ..................... Technical Questions and Support
  42.  
  43.  
  44.  
  45.  
  46.  
  47. 1. Introduction
  48.  
  49.  
  50.       Please take the time out to fill out the
  51. registration form which can be found on the CD; file
  52. name REGISTER.TXT. It is not required, but it would
  53. help us better serve you in the event of a problem with
  54. the CD, BBS file listing, ThePier database, or a
  55. particular software application. Also, by popular
  56. demand we will be offering an AUTO Pier Shareware
  57. Program which will allow you to receive a new CD as
  58. soon as it is released, for those of you that must have
  59. The Pier Shareware CD as soon as it is released. This
  60. program is only available to credit card holders.
  61. Please check the appropriate box, and fill out all of
  62. the registration form if you wish to participate in
  63. this program. Thank you for taking the time to fill out
  64. this form.
  65.  
  66. Congratulations on your purchase of one of The Pier
  67. Shareware CD-ROMs, the finest shareware CD-ROMs
  68. available.  ThePier CD-ROM Access program will assist
  69. you in finding files on your CD-ROM and performing
  70. common operations on those files.  It will allow you to
  71. view the filenames and descriptions of the files,
  72. search the CD-ROM files for filenames, keywords, and
  73. archive content filenames, and view many of the content
  74. files.
  75.  
  76.  
  77. 2. Installation
  78.  
  79.  
  80. To install ThePier CD-ROM Access program, change to the root 
  81. directory of The Pier Shareware CD-ROM and type INSTALL.  The
  82. install program will ask where on your hard drive you want 
  83. ThePier CD-ROM Access program to reside and will copy all 
  84. necessary files to that directory.  (For performance reasons, 
  85. ThePier must be installed to a hard disk.  It can not be run 
  86. directly from the CD-ROM.)  ThePier requires approximately 1MB
  87. of disk space for the program and associated data files.  
  88. Additional disk space will be used for the comments you enter
  89. in the comment database.
  90.  
  91.  
  92. 3. Basic Operation
  93.  
  94.  
  95. You should find ThePier very easy and intuitive to operate.  To 
  96. start ThePier, change to the directory where ThePier was 
  97. installed (for example, CD \THEPIER) and type THEPIER.  
  98.  
  99. ThePier is designed to use the best available video mode your 
  100. computer will support.  By default, it will try to use graphics 
  101. mode (EGA or VGA required) and resort to text mode if graphics
  102. mode is unavailable.  If you have problems viewing the screens 
  103. in graphics mode, you can force the program into text mode by 
  104. using a /T parameter on the command line (i.e. THEPIER /T).  
  105. Graphics mode also requires the file EGAVGA.BGI to be present in 
  106. the directory where THEPIER.EXE resides.  (The install program 
  107. will put it there.)  If this file isn't present, ThePier will 
  108. use a text mode display.
  109.  
  110. Online help is available throughout ThePier.  Press F1 to view
  111. the context-sensitive help screens.
  112.  
  113.  
  114. 4. The Subject List
  115.  
  116.  
  117. The first screen you see when you start ThePier is a list of the 
  118. subjects available on The Pier Shareware CD-ROM.  If you have a
  119. mouse on your system, a mouse pointer will be displayed.  You 
  120. can use the mouse to click on any of the subjects, the items on 
  121. the menu bar on the top of the screen, or on the scroll bar to
  122. the right of the screen.  If you click on a subject, a list of 
  123. the files in that subject will appear.  
  124.  
  125. 4.1  The Subject List Menu
  126.  
  127. At the top of the subject screen you'll see a drop-down menu bar 
  128. containing System, Search, and Configure.  
  129.  
  130. 4.1.1  The System Menu
  131.  
  132. At this point there are three options on the System menu:
  133.  
  134.     1) Shell to DOS, keeping ThePier in memory and ready 
  135.        to go when you type EXIT at the DOS prompt.  
  136.     2) Execute a Custom Shell program.  (This will be        
  137.        covered in more detail under Configuration.)      
  138.     3) Exit ThePier.
  139.  
  140. 4.1.2  The Search Menu
  141.  
  142. The Search menu will allow you to search ThePier database for
  143. matching file names, keywords, or content file names.  In this
  144. context, file names refers to the names of the files on The Pier
  145. Shareware CD-ROM, many of them archive files; keywords refers to
  146. significant words used in the file descriptions; and content
  147. file names refers to the files that are contained within the
  148. archive files.  At this point (on the Subjects List screen),
  149. searches will included all subjects.  If you wanted to search for
  150. all files that might have something to do with Windows, you would
  151. select Keyword from the search menu and type WINDOWS in the
  152. prompt box.  ThePier will then display a list of all the files
  153. containing the word "windows" somewhere in their description.
  154.  
  155. Wildcard characters are not recognized in search strings, but
  156. partial strings are allowed if the Exact Match box is not
  157. checked.  For instance, you could have entered WIN in the search
  158. above and matched all occurrences of Windows (along with all
  159. other keywords that begin with the letters WIN).
  160.  
  161. 4.1.3  The Configure Menu
  162.  
  163. The Configure menu allows you to change the operational
  164. parameters used by ThePier.  You can force the display to text
  165. mode (meaning you wouldn't need the /T on the command line),
  166. change the active database (useful if you have more than one The
  167. Pier Shareware CD-ROM), change the directories used by ThePier
  168. for temporary files, and set up viewer programs to be called
  169. automatically when certain files are selected. On all of the
  170. configuration screens, if you press ESCape, any changes you
  171. entered on that screen will be thrown away and the old data will
  172. be restored.
  173.  
  174. 4.1.3.1  Configure Display
  175.  
  176. The Configure Display screen allows a simple choice between
  177. forcing ThePier to use text mode displays or allowing it to use
  178. graphics mode displays.  (Graphics mode requires an EGA or VGA
  179. display system.)  Graphics mode displays are slightly larger than 
  180. text mode, allowing more subjects and files to be displayed on a 
  181. single screen, but they are slightly slower than text mode
  182. displays.  Other than these minor differences, the two modes are 
  183. functionally identical.
  184.  
  185. 4.1.3.2  Configure Database
  186.  
  187. The Configure Database screen can be used to select an alternate 
  188. ThePier database.  If you have more than one The Pier Shareware 
  189. CD-ROM you can use this screen to select the database associated 
  190. with one of the other CD-ROMs.  If you only have one The Pier 
  191. Shareware CD-ROM, do not change the settings on this screen.
  192.  
  193. You can select any of the directories shown in the lower right 
  194. section by clicking on them with your mouse.  If you don't have 
  195. a mouse, use the TAB key to switch to the directory section, 
  196. then use the arrow keys to highlight the desired directory.  
  197. Press the ENTER key to select the directory. 
  198.  
  199. If the desired directory is on another drive, position to the 
  200. Dir field and type the desired drive letter.
  201.  
  202. When you've selected the proper directory, position to the left 
  203. window and select the desired database file.  To finalize the 
  204. database selection, position to and select the OK button.
  205.  
  206. 4.1.3.3  Configure Directories
  207.  
  208. Directories Configuration allows you to specify the directories 
  209. used by ThePier.  The Work Directory is used by ThePier for 
  210. temporary files. A default value is set up by the installation 
  211. program, but you can change it if desired.  The Work Directory
  212. should be on a drive that has free space at least as large as
  213. the largest file you intend to view.  (Five megabytes should be
  214. more than sufficient.)
  215.  
  216. The Default Copy/Extract Directory specifies the default 
  217. directory used when copying or extracting archive files.  This 
  218. is just a default and can be changed on the fly when copying or
  219. extracting files.  
  220.  
  221. The Comment Database Directory specifies the location of the
  222. comment database.  By default, this is the directory where 
  223. ThePier program resides.  It is recommended that you stay with 
  224. the default.
  225.  
  226. CD-ROM Drive specifies the drive letter of your CD-ROM drive.  
  227. The installation program initially sets this value to the drive 
  228. from which ThePier was installed.  If you have more than one 
  229. CD-ROM drive, you will need to change this value if you move The 
  230. Pier Shareware CD-ROM to a different CD-ROM drive.
  231.  
  232. 4.1.3.4  Configure Viewers
  233.  
  234. The viewers are one of the nicest features of ThePier.  They allow you 
  235. to associate programs with data files on the basis of the data file 
  236. extension.  The Viewer configuration screen is divided into several 
  237. areas.  
  238.  
  239. 4.1.3.4.1  Default Viewer
  240.  
  241. At the top of the screen is the default viewer.  This is the
  242. viewer program that is called whenever the selected file does not 
  243. match one of the file extensions specified on this screen.  
  244. ThePier has a built-in viewer that is used as the default viewer 
  245. unless you specify something different.  Leave the Default Viewer 
  246. field blank if you want to use the built-in viewer.  (The 
  247. built-in viewer is designed to work only with plain ASCII text 
  248. files and will view only the first 32k bytes of any file.  If you 
  249. plan to view non-ASCII files or very large files, you will 
  250. probably want to specify a different program as the default 
  251. viewer.  Vern Buerg's LIST program is an excellent choice for the
  252. default viewer.)
  253.  
  254. To specify a different default viewer, enter what you would 
  255. normally type at the DOS command line to start that program.  
  256. Where you would ordinarily type the name of the file to be 
  257. viewed, enter $F.  ThePier will replace the $F with the name of 
  258. the file you've selected for viewing.  If you wanted to use Vern
  259. Buerg's LIST program as your default viewer, your default viewer
  260. line might look like:
  261.  
  262.       Default Viewer: LIST $F
  263.  
  264. 4.1.3.4.2  Custom Shell
  265.  
  266. The next field allows you to specify a "shell" program. This is 
  267. intended for use with DOS "shell" programs such as PCTools Shell 
  268. and Norton Commander.  ThePier will allow you to jump directly 
  269. to the program specified in this field and return to ThePier 
  270. when you exit the shell program.  If your DOS shell can accept a 
  271. directory on the command line, you can use $D to designate the
  272. current working directory.  If you use the Extract and Custom 
  273. Shell option, $D will be the directory into which the file was 
  274. extracted.  If you wanted to use PCTools Shell as your shell 
  275. program, your shell program line might look like:
  276.  
  277.         Shell Program: PCSHELL $D
  278.  
  279. 4.1.3.4.3  Smart Viewers
  280.  
  281. The other viewers are all paired with a line of file extensions
  282. associated with that viewer.  Anytime you select a file with an 
  283. extension from the viewer list, the viewer program associated 
  284. with that extension will be executed.  The viewer command lines 
  285. are just like the Default Viewer line as far as format goes.  
  286. Use $F in the command where you want the file name to go.
  287.  
  288.  
  289. 5.  The Files List
  290.  
  291.  
  292. When you select one of the subjects on the Subjects List, you'll 
  293. see a list of the files in that subject along with as much of 
  294. the file description as will fit on a single line.  If you select 
  295. one of the files by clicking on it with your mouse or pressing 
  296. enter when the file is highlighted, you'll see detailed 
  297. information about that file. 
  298.  
  299. 5.1  The Files List Menu
  300.  
  301. At the top of the files list screen you'll notice the menu bar
  302. has changed.  System is still there, though it now contains an 
  303. additional "Return to previous menu" item.  (You can also return 
  304. to the previous screen by pressing ESCape or clicking on the 
  305. little box in the upper left corner of the file list window.)  
  306. The Search menu is still there too, but its function has changed 
  307. a bit.  At this point searches will not scan the entire 
  308. database, but will be limited to the subject currently selected.
  309.  
  310.  
  311. 6.  The File Detail Screen
  312.  
  313.  
  314. The File Detail Screen contains detailed information about the 
  315. file you've selected.  In the upper left of the detail screen is 
  316. the file name, location, size, and date.  In the upper right is a 
  317. list of the contents of this file.  (If the file is not an 
  318. archive file, you'll just see the file name again.)  In the 
  319. middle of the screen is the full file description.  The scroll 
  320. bar at the right of the file description box can be used if the
  321. full description doesn't fit in the available lines.
  322.  
  323. Toward the bottom of the screen is a box where you can enter 
  324. your own comments about this file.  These comments will be saved 
  325. in a database on your hard disk and redisplayed when you view 
  326. this file's detail information again.  
  327.  
  328. At the very bottom of the screen is a prompt bar.  Pressing any 
  329. of the specified keys will perform the indicated action.  You 
  330. can also click with your mouse on any of the words to take the 
  331. indicated action.
  332.  
  333. 6.1  The Content List
  334.  
  335. The content list in the upper right of the detail screen is where 
  336. the viewers come in.  If you select one of the files in the 
  337. content list, that file will be extracted from the archive (if 
  338. necessary) and passed to the appropriate viewer program.  If no 
  339. viewer is associated with the selected file extension, the 
  340. default viewer will be used.  (When ThePier executes a viewer,
  341. it swaps all but about 10k of itself to EMS or to disk, so the
  342. viewer program should have plenty of memory available.)
  343.  
  344. 6.2  The File Detail Menu
  345.  
  346. At the top of the file detail screen you'll see the familiar 
  347. System menu along with a File menu.  The File menu will allow 
  348. you to copy a complete file or to extract an archive file.  If 
  349. you select either of these options, you'll be prompted for a 
  350. destination directory for the copy or extract operation.  These 
  351. directories will default to the Copy and Work directories
  352. specified in the configuration menu off the subjects screen.  
  353. You can change them by selecting a different directory from the 
  354. displayed list.  If you want the files to go to a different 
  355. drive, you'll have to type the drive letter on the directory 
  356. line.
  357.  
  358. The File menu will also allow you to Extract and execute the 
  359. Custom Shell or Extract and Shell to DOS.  Both of these options 
  360. will allow you to select a directory for the extract operation
  361. and will then either execute your Custom Shell or shell to DOS in
  362. the extraction directory.
  363.  
  364.  
  365. 7.  Technical Questions and Support
  366.  
  367. If you have trouble installing ThePier(tm), contact The Pier
  368. Exchange at:
  369.  
  370.               Info (716) 875-4931
  371.               BBS (716) 875-3130
  372.  
  373. If you have detailed technical questions or comments about the
  374. access software, you can contact RoboSoft Systems, the authors of
  375. the retrieval engine, at:
  376.  
  377.                         RoboSoft Systems
  378.                         P.O. Box 2221
  379.                         Orange, CA  92669
  380.